Skip to main content
Minh Nong
💬
0 discussions

[API] user-service

Tài liệu này nhằm mục đích quản lý số lượng và chức năng của endpoints trong command-service. Người đọc có thể dựa vào tên của files và tên endpoints để dễ dàng kiểm tra thông tin apis source code.​

API Endpoints​

Response​

  • 200: Success
  • 403: Forbidden
  • 400: Bad Request

Auth​

  • Auth Type : Bearer Token

index.js​

Delete User​

  • Route: /callcenter/:callcenter_id/user
  • Method: DELETE
  • Param: callcenter_id
  • Return Format:
    • Success: { success: true }
    • Failure: { success: false, error: { message: error } }

agent_logs.js​

Create Agent Logs​

  • Route: /callcenter/:idCallcenter/agent/logs
  • Method: POST
  • Query: versionSchema
  • Param: idCallcenter
  • Body: idAgent, status, device
  • Method: POST
  • Return Format:
    • Success: { success: true, result }
    • Failure: { success: false, error: { message: error } }

agent.js​

Create Agent​

  • Route: /callcenter/:callcenter_id/agent
  • Method: POST
  • Param: callcenter_id
  • Query: versionSchema
  • Body: idUser, role, idSip,
  • Return Format:
    • Success: { success: true, result }
    • Failure: { success: false, error: { message: error } }

Get Agent by ID​

  • Route: /callcenter/:callcenter_id/agent/:agent_id
  • Method: GET
  • Param: callcenter_id, agent_id
  • Return Format:
    • Success : 200 { success: true, result }
    • Failure : 400 { success: false, error: { message: error } }

Update Agent by ID​

  • Route: /callcenter/:callcenter_id/agent/:agent_id
  • Method: PUT
  • Param: callcenter_id, agent_id
  • Query: versionSchema
  • Body: field, value, role, idSip, accessPermission, deleted, isActive, idTeam
  • Return Format:
    • Success : 200 { success: true, result }
    • Failure : 400 { success: false, error: { message: error } }

Delete Agent by ID​

  • Route: /callcenter/:callcenter_id/agent/:agent_id
  • Method: DELETE
  • Param: callcenter_id, agent_id
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Get All Agents​

  • Route: /callcenter/:callcenter_id/agents/all
  • Method: GET
  • Param: callcenter_id
  • Query: filter
  • Return Format:
    • Success: { success: true, result: final }
    • Failure: { success: false, error: { message: error } }

Agent Signup​

  • Route: /callcenter/:callcenter_id/signup
  • Method: POST
  • Param: callcenter_id
  • Query: versionSchema
  • Body: _id
  • Return Format:
    • Success: { success: true, result: result }
    • Failure: { success: false, error: { message: error } }

role.js​

Create Role​

  • Route: /callcenter/:callcenter_id/role
  • Method: POST
  • Param: callcenter_id
  • Query: versionSchema
  • Body: name,
  • Return Format:
    • Success: 200 { success: true, result: result }
    • Failure: 400 { success: false, error: { message: error } }

Get Role by ID​

  • Route: /callcenter/:callcenter_id/role/:role_id
  • Method: GET
  • Param: callcenter_id, role_id
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true, result: result }
    • Failure : 400 { success: false, error: { message: error } }

Update Role by ID​

  • Route: /callcenter/:callcenter_id/role/:role_id
  • Method: PUT
  • Param: callcenter_id, role_id
  • Query: versionSchema
  • Body: req.body
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Delete Role by ID​

  • Route: /callcenter/:callcenter_id/role/:role_id
  • Method: DELETE
  • Param: callcenter_id, role_id
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Get All Roles​

  • Route: /callcenter/:callcenter_id/roles/all
  • Method: GET
  • Param: callcenter_id
  • Return Format:
    • Success : 200 { success: true, result: result }
    • Failure : 400 { success: false, error: { message: error } }

sip_account.js​

Create SIP Account​

  • Route: /callcenter/:callcenter_id/sipaccount
  • Method: POST
  • Param: callcenter_id
  • Query: versionSchema
  • Body: domain, extension, password, websocket, proxy
  • Return Format:
    • Success : { success: true, result }
    • Failure: { success: false, error: { message: error } }

Get SIP Account by ID​

  • Route: /callcenter/:callcenter_id/sipaccount/:sipaccount_id
  • Method: GET
  • Param: callcenter_id, sipaccount_id
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true, result }
    • Failure : 400 { success: false, error: { message: error } }

Put SIP Account by ID​

  • Route: /callcenter/:callcenter_id/sipaccount/:sipaccount_id
  • Method: PUT
  • Query: versionSchema
  • Body: field, value, domain, extension, password, proxy, websocket, deleted
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Delete SIP Account by ID​

  • Route: /callcenter/:callcenter_id/sipaccount/:sipaccount_id
  • Method: DELETE
  • Param: callcenter_id, sipaccount_id
  • Return Format:
    • Success : 200 { "success": true, "result": {} }
    • Failure : 400 { success: false, error: { message: error } }

Get All SIP Accounts​

  • Route: /callcenter/:callcenter_id/sipaccounts/all
  • Method: GET
  • Param: callcenter_id
  • Query: req.query
  • Return Format:
    • Success: { success: true, result }
    • Failure: { success: false, error: { message: error } }

team.js​

Create Team​

  • Route: /callcenter/:callcenter_id/team/
  • Method: POST
  • Body: leaders,name
  • Param: callcenter_id
  • Query: versionSchema
  • Return Format:
    • Success: 200 { success: true, data: result }
    • Failure: 400 { success: false, error: { message: error } }

Get Team by ID​

  • Route: /callcenter/:callcenter_id/team/:id
  • Method: GET
  • Param: callcenter_id, id
  • Return Format:
    • Success : 200 { success: true, result: result }
    • Failure : 400 { success: false, error: { message: error } }

Update Team by ID​

  • Route: /callcenter/:callcenter_id/team/:id
  • Method: PUT
  • Param: callcenter_id, id
  • Body: name, leaders
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Delete Team by ID​

  • Route: /callcenter/:callcenter_id/team/:id
  • Method: DELETE
  • Param: callcenter_id, id
  • Query: versionSchema
  • Return Format:
    • Success : 200 { success: true }
    • Failure : 400 { success: false, error: { message: error } }

Get All Teams​

  • Route: /callcenter/:callcenter_id/teams/all
  • Method: GET
  • Param: callcenter_id, id
  • Return Format:
    • Success: 200 { success: true, data }
    • Failure: 400 { success: false, error: { message: error } }